/*-------------------------------------------------------------------------
 *
 * fd.h
 *	  虚拟文件描述符定义.
 *
 *
 * Portions Copyright (c) 1996-2022, PostgreSQL Global Development Group
 * Portions Copyright (c) 1994, Regents of the University of California
 *
 * src/include/storage/fd.h
 *
 *-------------------------------------------------------------------------
 */

/*
 * 调用：
 *
 *	File {Close, Read, Write, Size, Sync}
 *	{Path Name Open, Allocate, Free} 文件
 *
 * 这些不仅仅是 UNIX 例程的重命名。
 * 将它们用于所有文件活动...
 *
 *	File fd;
 *	fd = PathNameOpenFile("foo", O_RDONLY);
 *
 *	AllocateFile();
 *	FreeFile();
 *
 * 如果你需要一个标准输入输出文件 (FILE*)，请使用 AllocateFile，而不是 fopen；然后使用 FreeFile，而不是 fclose，来关闭它。 避免对你打算保持打开一段时间的文件使用 stdio，因为没有办法与其他文件共享内核文件描述符。
 *
 * 同样，使用 AllocateDir/FreeDir，而不是 opendir/closedir，来分配打开的目录 (DIR*)，使用 OpenTransientFile/CloseTransientFile 来处理未缓冲的文件描述符。
 *
 * 如果你真的不能使用上述任何一个，至少调用 AcquireExternalFD 或 ReserveExternalFD 来报告任何保持一段时间的文件描述符。不这样做可能导致不必要的 EMFILE 错误。
 */
#ifndef FD_H
#define FD_H

#include <dirent.h>

typedef enum RecoveryInitSyncMethod
{
	RECOVERY_INIT_SYNC_METHOD_FSYNC,
	RECOVERY_INIT_SYNC_METHOD_SYNCFS
}			RecoveryInitSyncMethod;

struct iovec;					/* 避免在此处包含 port/pg_iovec.h */

typedef int File;


/* GUC 参数 */
extern PGDLLIMPORT int max_files_per_process;
extern PGDLLIMPORT bool data_sync_retry;
extern PGDLLIMPORT int recovery_init_sync_method;

/*
 * 这是 fd.c 私有的，但为 save/restore_backend_variables() 导出
 */
extern PGDLLIMPORT int max_safe_fds;

/*
 * 在 Windows 上，我们必须将 EACCES 解释为可能意味着与 ENOENT 相同，因为如果文件在该平台上被取消链接但尚未消失，
 * 那就是你得到的结果。呕。这段代码的设计目的是让我们在没有进一步证据的情况下不相信这些情况是可以的（即，一个待处理的 fsync 请求被取消...参见 ProcessSyncRequests）。
 */
#ifndef WIN32
#define FILE_POSSIBLY_DELETED(err)	((err) == ENOENT)
#else
#define FILE_POSSIBLY_DELETED(err)	((err) == ENOENT || (err) == EACCES)
#endif

/*
 * O_DIRECT 不是标准，但几乎所有 Unix 都有它。我们在 src/port/open.c 中将其翻译为适当的 Windows 标志。我们在 fd.c 的 open() 包装器内通过 fcntl(F_NOCACHE) 模拟它。在这种情况下，我们使用 PG_O_DIRECT 这个名称，而不是在 Unix 中定义 O_DIRECT（这可能不是个好主意）。
 */
#if defined(O_DIRECT)
#define		PG_O_DIRECT O_DIRECT
#elif defined(F_NOCACHE)
#define		PG_O_DIRECT 0x80000000
#define		PG_O_DIRECT_USE_F_NOCACHE
#else
#define		PG_O_DIRECT 0
#endif

/*
 * fd.c 中函数的原型
 */

/* 对虚拟文件的操作 --- 相当于 Unix 内核文件操作 */
extern File PathNameOpenFile(const char *fileName, int fileFlags);
extern File PathNameOpenFilePerm(const char *fileName, int fileFlags, mode_t fileMode);
extern File OpenTemporaryFile(bool interXact);
extern void FileClose(File file);
extern int	FilePrefetch(File file, off_t offset, int amount, uint32 wait_event_info);
extern int	FileRead(File file, char *buffer, int amount, off_t offset, uint32 wait_event_info);
extern int	FileWrite(File file, char *buffer, int amount, off_t offset, uint32 wait_event_info);
extern int	FileSync(File file, uint32 wait_event_info);
extern off_t FileSize(File file);
extern int	FileTruncate(File file, off_t offset, uint32 wait_event_info);
extern void FileWriteback(File file, off_t offset, off_t nbytes, uint32 wait_event_info);
extern char *FilePathName(File file);
extern int	FileGetRawDesc(File file);
extern int	FileGetRawFlags(File file);
extern mode_t FileGetRawMode(File file);

/* 用于共享命名临时文件的操作 */
extern File PathNameCreateTemporaryFile(const char *name, bool error_on_failure);
extern File PathNameOpenTemporaryFile(const char *path, int mode);
extern bool PathNameDeleteTemporaryFile(const char *name, bool error_on_failure);
extern void PathNameCreateTemporaryDir(const char *base, const char *name);
extern void PathNameDeleteTemporaryDir(const char *name);
extern void TempTablespacePath(char *path, Oid tablespace);

/* 允许使用标准输入输出的操作 --- 使用时请谨慎 */
extern FILE *AllocateFile(const char *name, const char *mode);
extern int	FreeFile(FILE *file);

/* 允许使用管道流（popen/pclose）的操作 */
extern FILE *OpenPipeStream(const char *command, const char *mode);
extern int	ClosePipeStream(FILE *file);

/* 允许使用 <dirent.h> 库例程的操作 */
extern DIR *AllocateDir(const char *dirname);
extern struct dirent *ReadDir(DIR *dir, const char *dirname);
extern struct dirent *ReadDirExtended(DIR *dir, const char *dirname,
									  int elevel);
extern int	FreeDir(DIR *dir);

/* 允许使用普通内核 FD 的操作，并带有自动清理功能 */
extern int	OpenTransientFile(const char *fileName, int fileFlags);
extern int	OpenTransientFilePerm(const char *fileName, int fileFlags, mode_t fileMode);
extern int	CloseTransientFile(int fd);

/* 如果你真的非常需要一个普通内核 FD，请使用这个 */
extern int	BasicOpenFile(const char *fileName, int fileFlags);
extern int	BasicOpenFilePerm(const char *fileName, int fileFlags, mode_t fileMode);

/* 将这些用于其他情况，以及用于长寿命的 BasicOpenFile FD */
extern bool AcquireExternalFD(void);
extern void ReserveExternalFD(void);
extern void ReleaseExternalFD(void);

/* 创建一个具有默认权限的目录 */
extern int	MakePGDirectory(const char *directoryName);

/* 杂项支持例程 */
extern void InitFileAccess(void);
extern void InitTemporaryFileAccess(void);
extern void set_max_safe_fds(void);
extern void closeAllVfds(void);
extern void SetTempTablespaces(Oid *tableSpaces, int numSpaces);
extern bool TempTablespacesAreSet(void);
extern int	GetTempTablespaces(Oid *tableSpaces, int numSpaces);
extern Oid	GetNextTempTableSpace(void);
extern void AtEOXact_Files(bool isCommit);
extern void AtEOSubXact_Files(bool isCommit, SubTransactionId mySubid,
							  SubTransactionId parentSubid);
extern void RemovePgTempFiles(void);
extern void RemovePgTempFilesInDir(const char *tmpdirname, bool missing_ok,
								   bool unlink_all);
extern bool looks_like_temp_rel_name(const char *name);

extern int	pg_fsync(int fd);
extern int	pg_fsync_no_writethrough(int fd);
extern int	pg_fsync_writethrough(int fd);
extern int	pg_fdatasync(int fd);
extern void pg_flush_data(int fd, off_t offset, off_t amount);
extern ssize_t pg_pwritev_with_retry(int fd,
									 const struct iovec *iov,
									 int iovcnt,
									 off_t offset);
extern int	pg_truncate(const char *path, off_t length);
extern void fsync_fname(const char *fname, bool isdir);
extern int	fsync_fname_ext(const char *fname, bool isdir, bool ignore_perm, int elevel);
extern int	durable_rename(const char *oldfile, const char *newfile, int loglevel);
extern int	durable_unlink(const char *fname, int loglevel);
extern int	durable_rename_excl(const char *oldfile, const char *newfile, int loglevel);
extern void SyncDataDirectory(void);
extern int	data_sync_elevel(int elevel);

/* 文件名组件 */
#define PG_TEMP_FILES_DIR "pgsql_tmp"
#define PG_TEMP_FILE_PREFIX "pgsql_tmp"

#endif							/* FD_H */
